home *** CD-ROM | disk | FTP | other *** search
/ Die Speccy' 97 / Die Speccy' 97.iso / amiga_system / the_aminet / dev / m2 / showerror.lha / ShowError.doc < prev    next >
Text File  |  1995-10-08  |  6KB  |  182 lines
  1. Documentation for ShowError V1.0, (c) 1995 by Frank L÷mker
  2.  
  3. E-Mail: floemker@techfak.uni-bielefeld.de
  4.  
  5. Copyright:
  6. ~~~~~~~~~
  7.  The program is Freeware. It is freely distributable and may be changed
  8.  and recompiled as long as no profit is taken out of it. Changes must be
  9.  documented.
  10.  
  11. Introduction:
  12. ~~~~~~~~~~~~
  13.  ShowError shows Turbo Modula-2 errors in most ARexx based Editors. It
  14.  reads the output of m2e, parses this and sends this information on
  15.  request to the Editor or back to ARexx.
  16.  
  17. Requirements:
  18. ~~~~~~~~~~~~
  19.  ShowError needs OS 2.0 and the following two external libraries:
  20.     - rexxsyslib.library
  21.     - mathieeedoubbas.library (loaded by rexxsyslib.library)
  22.  To use the program, you also need Turbo Modula-2 ((c) by Amritpal Mann,
  23.  a great compiler system) and an ARexx-editor.
  24.  
  25. Installation:
  26. ~~~~~~~~~~~~
  27.  - Rename "Modula:bin/m2e" to "Modula:bin/m2e2"
  28.  - Copy the script "m2e.script" to "Modula:bin/m2e" and change it to your
  29.    needs. It containes the following:
  30.  
  31.       .key name/a
  32.       m2e2 >t:errors "<name>"
  33.       type t:errors      ; not necessary
  34.  
  35.  - Set the s-bit of the file "Modula:bin/m2e"
  36.    i.e.: protect Modula:bin/m2e +s
  37.  - Copy ShowError to "Modula:bin"
  38.  - If ShowError should send messages directly to the editor:
  39.    Copy one of the files "ShowError.configXXX" to "Modula:s/ShowError.config"
  40.    and change it to your needs. There are config-files for different
  41.    editors included in the archive. The XXX stands for the name of the
  42.    Editor. If you use an other editor, copy one of the included
  43.    config-files and change it to your needs.
  44.  
  45. Config-File:
  46. ~~~~~~~~~~~
  47.  After the start of the program ShowError tries to load
  48.  "Modula:s/ShowError.config". This ASCII-file contains the information
  49.  for the direct communication with the editor. The keywords must start
  50.  in the first column and end with a "=" (after optional spaces).
  51.  
  52.  The keywords:
  53.  
  54.    PORT = name
  55.      The name of the port to which ShowError sends the messages.
  56.  
  57.    LINE = string
  58.      The first string ShowError sends if an error should be displayed.
  59.      This string is first parsed by Exec.RawDoFmt with the line and the
  60.      column as parameters (in this order). So this string can contain
  61.      one or two "%ld".
  62.  
  63.    COLUMN = string
  64.      The second string ShowError sends if an error should be displayed.
  65.      This string is first parsed by Exec.RawDoFmt with the column and the
  66.      line as parameters (in this order). So this string can contain one or
  67.      two "%ld".
  68.  
  69.    TEXT = string
  70.      The third string ShowError sends if an error should be displayed.
  71.      This string is first parsed by Exec.RawDoFmt with the number of the
  72.      current error, the number of all errors (this two in this order)
  73.      and the ErrorMessage as parameters. So this string can contain one
  74.      "%s" and one or two "%ld" in any order.
  75.  
  76.    MULTILINE = YES|NO      Default: NO
  77.      YES: After every WIDTH chars (see below) a newline is integrated in
  78.           the ErrorMessages.
  79.      NO : The ErrorMessages are shortened to WIDTH chars (see below).
  80.  
  81.    WIDTH = n               Default: 255
  82.      Dependent on MULTILINE (see above) the maximum length of the
  83.      ErrorMessages or the maximum length of the lines of the
  84.      ErrorMessages.
  85.  
  86.    NOTIFY = string
  87.      If this string is given a notification on the file "t:errors" is
  88.      installed. Every time this file is changed ShowError sends this
  89.      string to the above port, reads the file "t:errors" and displayes
  90.      the first error.
  91.  
  92.    In all strings "\n" are replaced by newlines (ASCII 10).
  93.  
  94.  An example (for CED):
  95.  
  96. PORT  = rexx_ced
  97. TEXT  = okay1 Error %ld/%ld:\n%s
  98. LINE  = Jumpto %ld %ld
  99. COLUMN=
  100. MULTILINE= YES
  101. WIDTH = 72
  102. NOTIFY= cedtofront
  103.  
  104. Program Start:
  105. ~~~~~~~~~~~~~
  106.  After the start the program will test if it already runs. If so it sends
  107.  the arguments to the running version and quits. If not it executes the
  108.  arguments and then waits to be invoked by itself, by ARexx or by a
  109.  CTRL-C signal. If the program gets a CTRL-C signal it quits.
  110.  
  111.  The arguments:
  112.  
  113.  Template: PORT/K,QUIT/S,READ/S,FIRST/S,NEXT/S,PREV/S
  114.  
  115.  PORT
  116.    This argument overwrites the port from "Modula:s/ShowError.config".
  117.    If the editor opens an own port for every text this argument can
  118.    perhaps help.
  119.  
  120.  QUIT
  121.    Quit every ShowError (the possibly running version and the current).
  122.  
  123.  READ
  124.    Read errors from "t:Errors" and display the first error.
  125.  
  126.  FIRST
  127.    Display the first error.
  128.  
  129.  NEXT
  130.    Display the next error.
  131.  
  132.  PREV
  133.    Display the previous error.
  134.  
  135.  The errors can only displayed if a correct config-file
  136.  "Modula:s/ShowError.config" exists.
  137.  
  138. ARexx-Port:
  139. ~~~~~~~~~~
  140.  ShowError has an ARexx port "SHOWERROR" with the following commands:
  141.  
  142.  PORT <name>
  143.    <name> overwrites the port from "Modula:s/ShowError.config". If the
  144.    editor opens an own port for every text this argument can perhaps help.
  145.  
  146.  QUIT
  147.    Quit ShowError.
  148.  
  149.  READ
  150.    Read errors from "t:Errors", display the first error and return the
  151.    text of the first error.
  152.  
  153.  FIRST
  154.    Display the first error and return the text of the error.
  155.  
  156.  NEXT
  157.    Display the next error and return the text of the error.
  158.  
  159.  PREV
  160.    Display the previous error and return the text of the error.
  161.  
  162.  LINE
  163.    Return the line of the current error.
  164.  
  165.  COLUMN 
  166.    Return the column of the current error.
  167.  
  168.  The errors can only displayed if a correct config-file
  169.  "Modula:s/ShowError.config" exists.
  170.  The information (text, line and column) is only returned if there was
  171.  an "options results" in the ARexx-script in front of the command.
  172.  
  173.  Error codes:
  174.  
  175.     rc   commands                      error
  176.  
  177.      5   NEXT                          No more errors
  178.      5   PREV                          No previous error
  179.     10   FIRST,NEXT,PREV,LINE,COLUMN   No Errorfile loaded
  180.     15   READ                          Unable to load "t:Errors"
  181.     20   ----                          Unknown command
  182.